'\" te
.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
.\" Copyright 2019 Joyent, Inc.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH LIBCPC 3LIB "March 25, 2019"
.SH NAME
libcpc \- CPU performance counter library
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... \fB-lcpc\fR [ \fIlibrary\fR... ]
.fi

.SH DESCRIPTION
.LP
Functions in this library provide access to CPU performance counters on
platforms that contain the appropriate hardware. A more detailed
explanation of the library and a list of processor-specific events is
available in \fBcpc\fR(3CPC).
.SH INTERFACES
.LP
The shared object \fBlibcpc.so.1\fR provides the public interfaces defined
below. See \fBIntro\fR(3) for additional information on shared object
interfaces.
.sp

.sp
.TS
l l
l l .
\fBcpc_access\fR	\fBcpc_bind_cpu\fR
\fBcpc_bind_curlwp\fR	\fBcpc_bind_event\fR
\fBcpc_bind_pctx\fR	\fBcpc_buf_add\fR
\fBcpc_buf_copy\fR	\fBcpc_buf_create\fR
\fBcpc_buf_destroy\fR	\fBcpc_buf_get\fR
\fBcpc_buf_hrtime\fR	\fBcpc_buf_set\fR
\fBcpc_buf_sub\fR	\fBcpc_buf_tick\fR
\fBcpc_buf_zero\fR	\fBcpc_caps\fR
\fBcpc_cciname\fR	\fBcpc_close\fR
\fBcpc_cpuref\fR	\fBcpc_count_sys_events\fR
\fBcpc_count_usr_events\fR	\fBcpc_disable\fR
\fBcpc_enable\fR	\fBcpc_event_accum\fR
\fBcpc_event_diff\fR	\fBcpc_eventtostr\fR
\fBcpc_getcciname\fR	\fBcpc_getcpuref\fR
\fBcpc_getcpuver\fR	\fBcpc_getnpic\fR
\fBcpc_getusage\fR	\fBcpc_npic\fR
\fBcpc_open\fR	\fBcpc_pctx_bind_event\fR
\fBcpc_pctx_invalidate\fR	\fBcpc_pctx_rele\fR
\fBcpc_pctx_take_sample\fR	\fBcpc_rele\fR
\fBcpc_request_preset\fR	\fBcpc_set_add_request\fR
\fBcpc_set_create\fR	\fBcpc_set_destroy\fR
\fBcpc_set_restart\fR	\fBcpc_set_sample\fR
\fBcpc_seterrfn\fR	\fBcpc_seterrhndlr\fR
\fBcpc_shared_bind_event\fR	\fBcpc_shared_close\fR
\fBcpc_shared_open\fR	\fBcpc_shared_rele\fR
\fBcpc_shared_take_sample\fR	\fBcpc_strtoevent\fR
\fBcpc_take_sample\fR	\fBcpc_unbind\fR
\fBcpc_version\fR	\fBcpc_walk_attrs\fR
\fBcpc_walk_events_all\fR	\fBcpc_walk_events_pic\fR
\fBcpc_walk_generic_events_all\fR	\fBcpc_walk_generic_events_pic\fR
\fBcpc_walk_names\fR	\fBcpc_walk_requests\fR
.TE

.SH FILES
.ne 2
.na
\fB\fB/usr/lib/libcpc.so.1\fR\fR
.ad
.RS 27n
shared object
.RE

.sp
.ne 2
.na
\fB\fB/usr/lib/64/libcpc.so.1\fR\fR
.ad
.RS 27n
64-bit shared object
.RE

.SH ATTRIBUTES
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
MT-Level	Safe
.TE

.SH SEE ALSO
.LP
.BR cputrack (1),
.BR Intro (3),
.BR cpc (3CPC),
.BR attributes (7),
.BR xVM (7),
.BR cpustat (8)
.SH NOTES
.LP
There is no support for access to performance counters in the \fBxVM\fR(7)
environment. The \fB-h\fR operations for \fBcputrack\fR(1) are not enabled.
